ApiKeyAuth

interface ApiKeyAuth
Content copied to clipboard

Exposes functionality for a user to manage API keys under their control.

Functions

create
Link copied to clipboard
abstract suspend fun create(name: String): ApiKey
Content copied to clipboard
Creates a user API key that can be used to authenticate as the user.
delete
Link copied to clipboard
abstract suspend fun delete(id: ObjectId)
Content copied to clipboard
Deletes a specific API key created by the user.
abstract suspend fun delete(id: BsonObjectId)
Content copied to clipboard
Deletes a specific API key created by the user.
disable
Link copied to clipboard
abstract suspend fun disable(id: ObjectId)
Content copied to clipboard
Deletes a specific API key created by the user.
abstract suspend fun disable(id: BsonObjectId)
Content copied to clipboard
Deletes a specific API key created by the user.
enable
Link copied to clipboard
abstract suspend fun enable(id: ObjectId)
Content copied to clipboard
Enables a specific API key created by the user.
abstract suspend fun enable(id: BsonObjectId)
Content copied to clipboard
Enables a specific API key created by the user.
fetch
Link copied to clipboard
abstract suspend fun fetch(id: ObjectId): ApiKey?
Content copied to clipboard
Fetches a specific user API key associated with the user.
abstract suspend fun fetch(id: BsonObjectId): ApiKey?
Content copied to clipboard
Fetches a specific user API key associated with the user.
fetchAll
Link copied to clipboard
abstract suspend fun fetchAll(): List<ApiKey>
Content copied to clipboard
Fetches all API keys associated with the user.

Properties

app
Link copied to clipboard
abstract val app: App
Content copied to clipboard
The App that this instance in associated with.
user
Link copied to clipboard
abstract val user: User
Content copied to clipboard
The User that this instance in associated with.